<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: DemonstrationRecorder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">DemonstrationRecorder Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The Demonstration Recorder component facilitates the recording of demonstrations used for imitation learning.  
 <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#details">More...</a></p>

<p>Inherits MonoBehaviour.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7f7a3199c392465d0767c6506c1af5b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a7f7a3199c392465d0767c6506c1af5b4">Close</a> ()</td></tr>
<tr class="memdesc:a7f7a3199c392465d0767c6506c1af5b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> and remove it from the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a7f7a3199c392465d0767c6506c1af5b4">More...</a><br /></td></tr>
<tr class="separator:a7f7a3199c392465d0767c6506c1af5b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f59773d2c8de8dd6c2ada11316de844"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a5f59773d2c8de8dd6c2ada11316de844">AddDemonstrationWriterToAgent</a> (<a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html">DemonstrationWriter</a> demoWriter)</td></tr>
<tr class="memdesc:a5f59773d2c8de8dd6c2ada11316de844"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add additional <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> to the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a5f59773d2c8de8dd6c2ada11316de844">More...</a><br /></td></tr>
<tr class="separator:a5f59773d2c8de8dd6c2ada11316de844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f1a60f93d0be7aae7dc0757f244a9d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a4f1a60f93d0be7aae7dc0757f244a9d0">RemoveDemonstrationWriterFromAgent</a> (<a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html">DemonstrationWriter</a> demoWriter)</td></tr>
<tr class="memdesc:a4f1a60f93d0be7aae7dc0757f244a9d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove additional <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> to the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a4f1a60f93d0be7aae7dc0757f244a9d0">More...</a><br /></td></tr>
<tr class="separator:a4f1a60f93d0be7aae7dc0757f244a9d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9c83971967b1b4b0dca9f62bb3aedad6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a9c83971967b1b4b0dca9f62bb3aedad6">Record</a></td></tr>
<tr class="memdesc:a9c83971967b1b4b0dca9f62bb3aedad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not to record demonstrations.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a9c83971967b1b4b0dca9f62bb3aedad6">More...</a><br /></td></tr>
<tr class="separator:a9c83971967b1b4b0dca9f62bb3aedad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ec7b0cdb5b6133f5c128a52f9522424"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a9ec7b0cdb5b6133f5c128a52f9522424">DemonstrationName</a></td></tr>
<tr class="memdesc:a9ec7b0cdb5b6133f5c128a52f9522424"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base demonstration file name.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#a9ec7b0cdb5b6133f5c128a52f9522424">More...</a><br /></td></tr>
<tr class="separator:a9ec7b0cdb5b6133f5c128a52f9522424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc9e21fb0cbf473159e142db3101a665"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#abc9e21fb0cbf473159e142db3101a665">DemonstrationDirectory</a></td></tr>
<tr class="memdesc:abc9e21fb0cbf473159e142db3101a665"><td class="mdescLeft">&#160;</td><td class="mdescRight">Directory to save the demo files.  <a href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html#abc9e21fb0cbf473159e142db3101a665">More...</a><br /></td></tr>
<tr class="separator:abc9e21fb0cbf473159e142db3101a665"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The Demonstration Recorder component facilitates the recording of demonstrations used for imitation learning. </p>
<p>Add this component to the <a href="https://docs.unity3d.com/Manual/GameObjects.html">GameObject</a> containing an <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> to enable recording the agent for imitation learning. You must implement the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html#aa0e01de85276d0b7a79299d9d26b81dc" title="Implement Heuristic() to choose an action for this agent using a custom heuristic.">Agent.Heuristic</a> function of the agent to provide manual control in order to record demonstrations.</p>
<p>See <a href="https://github.com/Unity-Technologies/ml-agents/blob/release_6_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations">Imitation Learning - Recording Demonstrations</a> for more information.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5f59773d2c8de8dd6c2ada11316de844"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f59773d2c8de8dd6c2ada11316de844">&#9670;&nbsp;</a></span>AddDemonstrationWriterToAgent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddDemonstrationWriterToAgent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html">DemonstrationWriter</a>&#160;</td>
          <td class="paramname"><em>demoWriter</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add additional <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> to the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>. </p>
<p>It is still up to the user to Close this DemonstrationWriters when recording is done.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">demoWriter</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7f7a3199c392465d0767c6506c1af5b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f7a3199c392465d0767c6506c1af5b4">&#9670;&nbsp;</a></span>Close()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Close the <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> and remove it from the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>. </p>
<p>Has no effect if the <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> is already closed (or wasn't opened)</p>

</div>
</div>
<a id="a4f1a60f93d0be7aae7dc0757f244a9d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f1a60f93d0be7aae7dc0757f244a9d0">&#9670;&nbsp;</a></span>RemoveDemonstrationWriterFromAgent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RemoveDemonstrationWriterFromAgent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html">DemonstrationWriter</a>&#160;</td>
          <td class="paramname"><em>demoWriter</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remove additional <a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationWriter.html" title="Responsible for writing demonstration data to stream (typically a file stream).">DemonstrationWriter</a> to the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>. </p>
<p>It is still up to the user to Close this DemonstrationWriters when recording is done.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">demoWriter</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abc9e21fb0cbf473159e142db3101a665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc9e21fb0cbf473159e142db3101a665">&#9670;&nbsp;</a></span>DemonstrationDirectory</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string DemonstrationDirectory</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Directory to save the demo files. </p>
<p>Will default to a "Demonstrations/" folder in the Application data path if not specified.</p>

</div>
</div>
<a id="a9ec7b0cdb5b6133f5c128a52f9522424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ec7b0cdb5b6133f5c128a52f9522424">&#9670;&nbsp;</a></span>DemonstrationName</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string DemonstrationName</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base demonstration file name. </p>
<p>If multiple files are saved, the additional filenames will have a sequence of unique numbers appended.</p>

</div>
</div>
<a id="a9c83971967b1b4b0dca9f62bb3aedad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c83971967b1b4b0dca9f62bb3aedad6">&#9670;&nbsp;</a></span>Record</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Record</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether or not to record demonstrations. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DemonstrationRecorder_8cs.html">DemonstrationRecorder.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Demonstrations.html">Demonstrations</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1Demonstrations_1_1DemonstrationRecorder.html">DemonstrationRecorder</a></li>
  </ul>
</div>
</body>
</html>
